﻿/*

  The contents of this file are subject to the Mozilla Public License Version
  1.1 (the "License"); you may not use this file except in compliance with
  the License. You may obtain a copy of the License at 
  
           http://www.mozilla.org/MPL/ 
  
  Software distributed under the License is distributed on an "AS IS" basis,
  WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  for the specific language governing rights and limitations under the License. 
  
  The Original Code is AST'r Framework.
  
  The Initial Developer of the Original Code is
  ALCARAZ Marc (aka eKameleon) <vegas@ekameleon.net>.
  Portions created by the Initial Developer are Copyright (C) 2004-2007
  the Initial Developer. All Rights Reserved.
  
  Contributor(s) :
  
*/

import andromeda.util.visitor.IVisitor;

import ewhiteboard.display.whiteboard.WhiteBoardDisplay;
import ewhiteboard.vo.ShapeVO;

/**
 * This interface determinates the ITool methods.
 * @author eKameleon
 */
interface ewhiteboard.tools.whiteboard.IWhiteBoardTool extends IVisitor
{
	
	/**
	 * Returns the owner WhiteBoardDisplay reference of this tool.
	 * @return the owner WhiteBoardDisplay reference of this tool.
	 */	
	function getOwner():WhiteBoardDisplay ;
	
	/**
	 * Returns the shape value object of this tool.
	 * @return the shape value object of this tool.
	 */
	function getShapeVO():ShapeVO ;

	/**
	 * Returns the type of this tool.
	 * @return the type of this tool.
	 */
	function getWhiteBoardType():Number ;

	/**
	 * Invoqued when the tool is moved.
	 */
	function move():Void ; 

	/**
	 * Reset the tool.
	 */
	function reset():Void ;

	/**
	 * Sets the owner WhiteBoardDisplay reference of this tool.
	 */	
	function setOwner( owner:WhiteBoardDisplay ):Void ;

	/**
	 * Start the tool process.
	 */
	function start():Void ;

	/**
	 * Stop the tool process.
	 */
	function stop():Void ;
		

}